home *** CD-ROM | disk | FTP | other *** search
/ Nebula 2 / Nebula Two.iso / SourceCode / MiscKit1.7.1 / MiscKit / Examples / AutoDoc / INSTALL < prev    next >
Encoding:
Text File  |  1995-11-02  |  2.6 KB  |  74 lines
  1. Thu Nov  2 13:03:00 1995 - autodoc version 1.8.4 release notes: INSTALL
  2.  
  3.  CONFIRMING AUTODOC RESOURCES
  4.     
  5. The complete autodoc package should include the following files:
  6. ----------------------------------------------------------------
  7.     CHANGES
  8.     README
  9.     INSTALL
  10.     bin/autodoc                                 (rev-1.5)
  11.     lib/perl5/Autodoc/DumpDocs.pm               (rev-1.3)
  12.     lib/perl5/Autodoc/GenerateRTF.pm            (rev-1.3)
  13.     lib/perl5/Autodoc/ParseComments.pm          (rev-1.2)
  14.     lib/perl5/Autodoc/ReadSource.pm             (rev-1.2)
  15.     lib/perl5/Autodoc/ScanFile.pm               (rev-1.2)
  16.     lib/perl5/Autodoc/FileSupport.pm            (rev-1.3)
  17.     lib/perl5/Autodoc/LogDebug.pm               (rev-1.2)
  18.     Guide/Autodoc.rtf
  19.     htdocs/Autodoc.html
  20.     htdocs/Autodoc_OptsHist.html
  21.     Examples/README
  22.     Examples/Documentation/MyView.rtf
  23.     Examples/Documentation/MyFooProtocol.rtf
  24.     Examples/Source/MyView.h
  25.     Examples/Source/MyView.m
  26.     Examples/Source/MyFooProtocol.h
  27.     Examples/Source/MyFooProtocol.mdoc
  28.     Notes/TODO
  29.     Notes/BUGS
  30.  
  31.  
  32.  INSTALLING THE AUTODOC EXECUTABLE
  33.  
  34. The file autodoc should be copied to a directory which is in your execution path (eg. /usr/local/bin)
  35.  
  36.  
  37.  INSTALLING THE AUTODOC SUPPORT MODULES
  38.  
  39. The lib/perl5 modules (.pm files) should be copied to the directory where perl looks for its modules (usually: /usr/local/lib/perl5).  
  40.  
  41. For example, move DumpDocs.pm to "/usr/local/lib/perl5/Autodoc/DumpDocs.pm"
  42. Alternatively, you can set the environment variable AD_PMLIBDIR to specify an alternate location.  Note that AD_PMLIBDIR should refer to the directory containing the "Autodoc/*.pm" directory.
  43.  
  44.  
  45.  TESTING
  46.  
  47. To confirm that you have the correct version installed and is accessible in your path, try executing:
  48.     % autodoc -version
  49. You should see the following output (verbatim):
  50. -----------------------------------------------
  51. This is autodoc Release 1.8.4 (rev-1.5)
  52. Module versions:
  53.     FileSupport.pm (rev-1.3)
  54.     LogDebug.pm (rev-1.2)
  55.     ScanFile.pm (rev-1.2)
  56.     ReadSource.pm (rev-1.2)
  57.     ParseComments.pm (rev-1.2)
  58.     DumpDocs.pm (rev-1.3)
  59.     GenerateRTF.pm (rev-1.3)
  60. Written by Adam Swift <aswift@friday.com>
  61. Copyright Friday Software and Consulting, 1995 - All Rights Reserved
  62. Please send bugs and suggestions to:<autodoc@friday.com>
  63. Contributions by:
  64.     Bill Bumgarner <bbum@friday.com>
  65.     Todd Anthony Nathan <todd@icebox.com>
  66.     Kim Shrier <kim@media.com>
  67.     Craig Kelley <ckelley@capaccess.org>
  68.  
  69.  
  70.  TROUBLE SHOOTING
  71.  
  72. If you run into trouble setting up your environment to run autodoc, read the installation section of the autodoc guide to see a more detailed description of how to configure autodoc to your environment.  If you still have problems, email me at: aswift@apdg.com
  73.  
  74.